<!DOCTYPE html>

<html lang="en">
<head>
	<meta charset="utf-8">
	<meta name="viewport" content="width=device-width">
	<title>Documentation Class: Netcall</title>

	<!--[if lt IE 9]>
	<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
	<![endif]-->
	<link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">

	<link type="text/css" rel="stylesheet" href="styles/site.simplex.css">

</head>

<body>

<div class="navbar navbar-default navbar-fixed-top ">
<div class="container">
	<div class="navbar-header">
		<a class="navbar-brand" href="index.html">Documentation</a>
		<button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#topNavigation">
			<span class="icon-bar"></span>
			<span class="icon-bar"></span>
			<span class="icon-bar"></span>
        </button>
	</div>
	<div class="navbar-collapse collapse" id="topNavigation">
		<ul class="nav navbar-nav">
			
			<li class="dropdown">
				<a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b class="caret"></b></a>
				<ul class="dropdown-menu ">
					<li><a href="blob.html">blob</a></li><li><a href="support.html">support</a></li><li><a href="global.html#util">util</a></li>
				</ul>
			</li>
			
			<li class="dropdown">
				<a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b class="caret"></b></a>
				<ul class="dropdown-menu ">
					<li><a href="Audio.html">Audio</a></li><li><a href="Chatroom.html">Chatroom</a></li><li><a href="ChatroomInfo.html">ChatroomInfo</a></li><li><a href="ChatroomMember.html">ChatroomMember</a></li><li><a href="ChatroomMessage.html">ChatroomMessage</a></li><li><a href="Collect.html">Collect</a></li><li><a href="Comment.html">Comment</a></li><li><a href="File.html">File</a></li><li><a href="Friend.html">Friend</a></li><li><a href="Geo.html">Geo</a></li><li><a href="Image.html">Image</a></li><li><a href="IMMessage.html">IMMessage</a></li><li><a href="LoginPort.html">LoginPort</a></li><li><a href="Netcall.html">Netcall</a></li><li><a href="NetcallWeixin.html">NetcallWeixin</a></li><li><a href="NIM.html">NIM</a></li><li><a href="NIMError.html">NIMError</a></li><li><a href="NRTC.html">NRTC</a></li><li><a href="Relation.html">Relation</a></li><li><a href="Session.html">Session</a></li><li><a href="Signaling.html">Signaling</a></li><li><a href="SuperTeam.html">SuperTeam</a></li><li><a href="SuperTeamMember.html">SuperTeamMember</a></li><li><a href="SystemMessage.html">SystemMessage</a></li><li><a href="Team.html">Team</a></li><li><a href="TeamMember.html">TeamMember</a></li><li><a href="User.html">User</a></li><li><a href="Video.html">Video</a></li><li><a href="WebRTC.html">WebRTC</a></li><li><a href="WebRTC_NRTC.html">WebRTC/NRTC</a></li><li><a href="WhiteBoard.html">WhiteBoard</a></li>
				</ul>
			</li>
			
			<li class="dropdown">
				<a href="events.list.html" class="dropdown-toggle" data-toggle="dropdown">Events<b class="caret"></b></a>
				<ul class="dropdown-menu ">
					<li><a href="NRTC.html#event:addTrack">NRTC#event:addTrack</a></li><li><a href="NRTC.html#event:audioVolume">NRTC#event:audioVolume</a></li><li><a href="NRTC.html#event:auidoMixingEnd">NRTC#event:auidoMixingEnd</a></li><li><a href="NRTC.html#event:deviceAdd">NRTC#event:deviceAdd</a></li><li><a href="NRTC.html#event:deviceRemove">NRTC#event:deviceRemove</a></li><li><a href="NRTC.html#event:deviceStatus">NRTC#event:deviceStatus</a></li><li><a href="NRTC.html#event:error">NRTC#event:error</a></li><li><a href="NRTC.html#event:gatewayClosed">NRTC#event:gatewayClosed</a></li><li><a href="NRTC.html#event:joinChannel">NRTC#event:joinChannel</a></li><li><a href="NRTC.html#event:leaveChannel">NRTC#event:leaveChannel</a></li><li><a href="NRTC.html#event:recordStopped">NRTC#event:recordStopped</a></li><li><a href="NRTC.html#event:remoteTrack">NRTC#event:remoteTrack</a></li><li><a href="NRTC.html#event:removeTrack">NRTC#event:removeTrack</a></li><li><a href="NRTC.html#event:streamEnded">NRTC#event:streamEnded</a></li><li><a href="NRTC.html#event:userJoined">NRTC#event:userJoined</a></li><li><a href="NRTC.html#event:userLeft">NRTC#event:userLeft</a></li><li><a href="NRTC.html#event:userStateUpdated">NRTC#event:userStateUpdated</a></li><li><a href="WebRTC.html#event:beCalling">WebRTC#event:beCalling</a></li><li><a href="WebRTC.html#event:callAccepted">WebRTC#event:callAccepted</a></li><li><a href="WebRTC.html#event:callerAckSync">WebRTC#event:callerAckSync</a></li><li><a href="WebRTC.html#event:callRejected">WebRTC#event:callRejected</a></li><li><a href="WebRTC.html#event:control">WebRTC#event:control</a></li><li><a href="WebRTC.html#event:hangup">WebRTC#event:hangup</a></li><li><a href="WebRTC.html#event:sessionDuration">WebRTC#event:sessionDuration</a></li>
				</ul>
			</li>
			
			<li class="dropdown">
				<a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b class="caret"></b></a>
				<ul class="dropdown-menu ">
					<li><a href="global.html#changeRoleToAudience">changeRoleToAudience</a></li><li><a href="global.html#changeRoleToPlayer">changeRoleToPlayer</a></li><li><a href="global.html#createProgram">createProgram</a></li><li><a href="global.html#filterClientAntispam">filterClientAntispam</a></li><li><a href="global.html#loadShader">loadShader</a></li><li><a href="global.html#obj">obj</a></li><li><a href="global.html#RTC_EVENTS">RTC_EVENTS</a></li>
				</ul>
			</li>
			
		</ul>
        
            <div class="col-sm-3 col-md-3">
                <form class="navbar-form" role="search">
                    <div class="input-group">
                        <input type="text" class="form-control" placeholder="Search" name="q" id="search-input">
                        <div class="input-group-btn">
                            <button class="btn btn-default" id="search-submit"><i class="glyphicon glyphicon-search"></i></button>
                        </div>
                    </div>
                </form>
            </div>
        
	</div>

</div>
</div>


<div class="container" id="toc-content">
<div class="row">

	
	<div class="col-md-8">
	
		<div id="main">
			

	<h1 class="page-title">Class: Netcall</h1>
<section>

<header>
    
        <h2>
        Netcall
        </h2>
        
    
</header>


<article>
    <div class="container-overview">
    
        
<hr>
<dt>
    <h4 class="name" id="Netcall"><span class="type-signature"></span>new Netcall()</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>请使用 <a href="Netcall.html#.getInstance"><code>Netcall.getInstance</code></a> 来初始化音视频.</p>
    </div>
    

    

    

    
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	

	

	

	
</dl>


    

    

    

    

    

    

    
</dd>

    
    </div>

    

    

    

    

    

    
        <h3 class="subsection-title">Members</h3>

        <dl>
            
<hr>
<dt class="name" id=".CHAT_NET_STATUS_*">
    <h4 id=".CHAT_NET_STATUS_*"><span class="type-signature">&lt;static, readonly> </span>CHAT_NET_STATUS_*<span class="type-signature"></span></h4>

    
</dt>
<dd>
    
    <div class="description">
        <p>网络状态类型</p>
<ul>
<li>Netcall.CHAT_NET_STATUS_VERY_GOOD 网络状态很好</li>
<li>Netcall.CHAT_NET_STATUS_GOOD 网络状态较好</li>
<li>Netcall.CHAT_NET_STATUS_POOR 网络状态较差</li>
<li>Netcall.CHAT_NET_STATUS_BAD 网络状态很差</li>
<li>Netcall.CHAT_NET_STATUS_VERY_BAD 网络状态极差，考虑是否关闭视频</li>
<li>Netcall.CHAT_NET_STATUS_VERY_BAD_VIDEO_CLOSE 网络状态极差，视频强制关闭</li>
</ul>
    </div>
    

    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	

	

	

	
</dl>


    
</dd>

        
            
<hr>
<dt class="name" id=".CHAT_VIDEO_ENCODEMODE_*">
    <h4 id=".CHAT_VIDEO_ENCODEMODE_*"><span class="type-signature">&lt;static, readonly> </span>CHAT_VIDEO_ENCODEMODE_*<span class="type-signature"></span></h4>

    
</dt>
<dd>
    
    <div class="description">
        <p>视频编码策略</p>
<ul>
<li>Netcall.CHAT_VIDEO_ENCODEMODE_NORMAL 默认值，清晰优先</li>
<li>Netcall.CHAT_VIDEO_ENCODEMODE_SMOOTH 流畅优先</li>
<li>Netcall.CHAT_VIDEO_ENCODEMODE_QUALITY 清晰优先</li>
<li>Netcall.CHAT_VIDEO_ENCODEMODE_SCREEN 高清，不根据网络情况调整分辨率</li>
</ul>
    </div>
    

    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	

	

	

	
</dl>


    
</dd>

        
            
<hr>
<dt class="name" id=".CHAT_VIDEO_FRAME_RATE_*">
    <h4 id=".CHAT_VIDEO_FRAME_RATE_*"><span class="type-signature">&lt;static, readonly> </span>CHAT_VIDEO_FRAME_RATE_*<span class="type-signature"></span></h4>

    
</dt>
<dd>
    
    <div class="description">
        <p>视频通话帧率，实际帧率因画面采集频率和机器性能限制可能达不到期望值</p>
<ul>
<li>Netcall.CHAT_VIDEO_FRAME_RATE_NORMAL 视频通话帧率默认值 最大取每秒15帧</li>
<li>Netcall.CHAT_VIDEO_FRAME_RATE_5 视频通话帧率 最大取每秒5帧</li>
<li>Netcall.CHAT_VIDEO_FRAME_RATE_10 视频通话帧率 最大取每秒10帧</li>
<li>Netcall.CHAT_VIDEO_FRAME_RATE_15 视频通话帧率 最大取每秒15帧</li>
<li>Netcall.CHAT_VIDEO_FRAME_RATE_20 视频通话帧率 最大取每秒20帧</li>
<li>Netcall.CHAT_VIDEO_FRAME_RATE_25 视频通话帧率 最大取每秒25帧</li>
</ul>
    </div>
    

    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	

	

	

	
</dl>


    
</dd>

        
            
<hr>
<dt class="name" id=".CHAT_VIDEO_QUALITY_*">
    <h4 id=".CHAT_VIDEO_QUALITY_*"><span class="type-signature">&lt;static, readonly> </span>CHAT_VIDEO_QUALITY_*<span class="type-signature"></span></h4>

    
</dt>
<dd>
    
    <div class="description">
        <p>视频通话分辨率</p>
<ul>
<li>Netcall.CHAT_VIDEO_QUALITY_NORMAL 视频默认分辨率 640x480</li>
<li>Netcall.CHAT_VIDEO_QUALITY_LOW 视频低分辨率 176x144</li>
<li>Netcall.CHAT_VIDEO_QUALITY_MEDIUM 视频中分辨率 352x288</li>
<li>Netcall.CHAT_VIDEO_QUALITY_HIGH 视频高分辨率 480x320</li>
<li>Netcall.CHAT_VIDEO_QUALITY_480P 视频480p分辨率 640x480</li>
<li>Netcall.CHAT_VIDEO_QUALITY_540P 视频540P分辨率 960x540</li>
<li>Netcall.CHAT_VIDEO_QUALITY_720P 用于桌面分享级别的分辨率 1280x720 ，需要使用高清摄像头并指定对应的分辨率，或者自定义通道传输</li>
</ul>
    </div>
    

    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	

	

	

	
</dl>


    
</dd>

        
            
<hr>
<dt class="name" id=".CHAT_VIDEO_SCALE_*">
    <h4 id=".CHAT_VIDEO_SCALE_*"><span class="type-signature">&lt;static, readonly> </span>CHAT_VIDEO_SCALE_*<span class="type-signature"></span></h4>

    
</dt>
<dd>
    
    <div class="description">
        <p>视频画面按比例裁剪，裁剪时不改变横竖屏，默认不裁剪</p>
<ul>
<li>Netcall.CHAT_VIDEO_SCALE_None 长宽不裁剪，全部显示</li>
<li>Netcall.CHAT_VIDEO_SCALE_1x1 裁剪成1：1的形状</li>
<li>Netcall.CHAT_VIDEO_SCALE_4x3 裁剪成4：3的形状</li>
<li>Netcall.CHAT_VIDEO_SCALE_16x9 裁剪成16：9的形状</li>
</ul>
    </div>
    

    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	

	

	

	
</dl>


    
</dd>

        
            
<hr>
<dt class="name" id=".CLIENT_TYPE_*">
    <h4 id=".CLIENT_TYPE_*"><span class="type-signature">&lt;static, readonly> </span>CLIENT_TYPE_*<span class="type-signature"></span></h4>

    
</dt>
<dd>
    
    <div class="description">
        <p>端类型</p>
<ul>
<li>Netcall.CLIENT_TYPE_AOS Android</li>
<li>Netcall.CLIENT_TYPE_IOS iOS</li>
<li>Netcall.CLIENT_TYPE_PC pc</li>
<li>Netcall.CLIENT_TYPE_WINPHONE WinPhone</li>
<li>Netcall.CLIENT_TYPE_WEB web</li>
<li>Netcall.CLIENT_TYPE_REST rest</li>
</ul>
    </div>
    

    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	

	

	

	
</dl>


    
</dd>

        
            
<hr>
<dt class="name" id=".DEVICE_TYPE_*">
    <h4 id=".DEVICE_TYPE_*"><span class="type-signature">&lt;static, readonly> </span>DEVICE_TYPE_*<span class="type-signature"></span></h4>

    
</dt>
<dd>
    
    <div class="description">
        <p>设备类型</p>
<ul>
<li>Netcall.DEVICE_TYPE_AUDIO_IN 麦克风</li>
<li>Netcall.DEVICE_TYPE_AUDIO_OUT_LOCAL 用于播放自己声音的设备</li>
<li>Netcall.DEVICE_TYPE_AUDIO_OUT_CHAT 播放对方声音的扬声器</li>
<li>Netcall.DEVICE_TYPE_VIDEO 摄像头</li>
</ul>
    </div>
    

    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	

	

	

	
</dl>


    
</dd>

        
            
<hr>
<dt class="name" id=".LAYOUT_*">
    <h4 id=".LAYOUT_*"><span class="type-signature">&lt;static, readonly> </span>LAYOUT_*<span class="type-signature"></span></h4>

    
</dt>
<dd>
    
    <div class="description">
        <p>直播推流布局</p>
<ul>
<li>Netcall.LAYOUT_SPLITBOTTOMHORFLOATING 底部横排浮窗</li>
<li>Netcall.LAYOUT_SPLITTOPHORFLOATING 顶部横排浮窗</li>
<li>Netcall.LAYOUT_SPLITLATTICETILE 平铺</li>
<li>Netcall.LAYOUT_SPLITLATTICECUTTINGTILE 裁剪平铺</li>
<li>Netcall.LAYOUT_SPLITCUSTOMLAYOUT 自定义布局</li>
<li>Netcall.LAYOUT_SPLITAUDIOLAYOUT 纯音频布局</li>
</ul>
    </div>
    

    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	

	

	

	
</dl>


    
</dd>

        
            
<hr>
<dt class="name" id=".NETCALL_CONTROL_COMMAND_*">
    <h4 id=".NETCALL_CONTROL_COMMAND_*"><span class="type-signature">&lt;static, readonly> </span>NETCALL_CONTROL_COMMAND_*<span class="type-signature"></span></h4>

    
</dt>
<dd>
    
    <div class="description">
        <p>控制指令</p>
<ul>
<li>Netcall.NETCALL_CONTROL_COMMAND_NOTIFY_AUDIO_ON 通知对方自己打开了音频</li>
<li>Netcall.NETCALL_CONTROL_COMMAND_NOTIFY_AUDIO_OFF 通知对方自己关闭了音频</li>
<li>Netcall.NETCALL_CONTROL_COMMAND_NOTIFY_VIDEO_ON 通知对方自己打开了视频</li>
<li>Netcall.NETCALL_CONTROL_COMMAND_NOTIFY_VIDEO_OFF 通知对方自己关闭了视频</li>
<li>Netcall.NETCALL_CONTROL_COMMAND_SWITCH_AUDIO_TO_VIDEO 请求从音频切换到视频</li>
<li>Netcall.NETCALL_CONTROL_COMMAND_SWITCH_AUDIO_TO_VIDEO_AGREE 同意从音频切换到视频</li>
<li>Netcall.NETCALL_CONTROL_COMMAND_SWITCH_AUDIO_TO_VIDEO_REJECT 拒绝从音频切换到视频</li>
<li>Netcall.NETCALL_CONTROL_COMMAND_SWITCH_VIDEO_TO_AUDIO 从视频切换到音频</li>
<li>Netcall.NETCALL_CONTROL_COMMAND_BUSY 占线</li>
<li>Netcall.NETCALL_CONTROL_COMMAND_SELF_CAMERA_INVALID 自己的摄像头不可用</li>
<li>Netcall.NETCALL_CONTROL_COMMAND_SELF_AUDIO_INVALID 自己的麦克风不可用</li>
<li>Netcall.NETCALL_CONTROL_COMMAND_SELF_ON_BACKGROUND 自己处于后台</li>
<li>Netcall.NETCALL_CONTROL_COMMAND_START_NOTIFY_RECEIVED 告诉发送方自己已经收到请求了（用于通知发送方开始播放提示音）</li>
<li>Netcall.NETCALL_CONTROL_COMMAND_NOTIFY_RECORD_START 告诉对方自己开始录制视频了</li>
<li>Netcall.NETCALL_CONTROL_COMMAND_NOTIFY_RECORD_STOP 告诉对方自己结束录制视频了</li>
</ul>
    </div>
    

    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	

	

	

	
</dl>


    
</dd>

        
            
<hr>
<dt class="name" id=".NETCALL_TYPE_*">
    <h4 id=".NETCALL_TYPE_*"><span class="type-signature">&lt;static, readonly> </span>NETCALL_TYPE_*<span class="type-signature"></span></h4>

    
</dt>
<dd>
    
    <div class="description">
        <p>音视频通话类型</p>
<ul>
<li>Netcall.NETCALL_TYPE_AUDIO 音频</li>
<li>Netcall.NETCALL_TYPE_VIDEO 视频</li>
</ul>
    </div>
    

    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	

	

	

	
</dl>


    
</dd>

        
            
<hr>
<dt class="name" id=".NETDETECT_*">
    <h4 id=".NETDETECT_*"><span class="type-signature">&lt;static, readonly> </span>NETDETECT_*<span class="type-signature"></span></h4>

    
</dt>
<dd>
    
    <div class="description">
        <p>网络探测类型选择</p>
<ul>
<li>Netcall.NETDETECT_AUDIO 音频探测</li>
<li>Netcall.NETDETECT_VIDEO 视频探测</li>
</ul>
    </div>
    

    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	

	

	

	
</dl>


    
</dd>

        </dl>
    

    
        <h3 class="subsection-title">Methods</h3>

        <dl>
            
<hr>
<dt>
    <h4 class="name" id=".getInstance"><span class="type-signature">&lt;static> </span>getInstance(options)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>此接口为单例模式</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>options</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>



            
            </td>

            

            

            <td class="description last"><p>配置参数</p>
                <h6 class="method-params-label method-subparams-label">Properties</h6>
                

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>kickLast</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    false
                
                </td>
            

            <td class="description last"><p>是否踢掉上次的通话, 默认 false</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>nim</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="NIM.html">NIM</a></span>



            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>NIM 实例</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>container</code></td>
            

            <td class="type">
            
                
<span class="param-type">Node</span>



            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>播放自己视频画面的dom容器节点</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>remoteContainer</code></td>
            

            <td class="type">
            
                
<span class="param-type">Node</span>



            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>播放对方画面的dom容器节点</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>mirror</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    false
                
                </td>
            

            <td class="description last"><p>agent方式: 是否对自己的画面进行镜像处理, 默认 false</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>mirrorRemote</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    false
                
                </td>
            

            <td class="description last"><p>agent方式: 是否对对方的画面进行镜像处理, 默认 false</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>heartbeat</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    true
                
                </td>
            

            <td class="description last"><p>是否心跳（开发者调试用，为了避免断点调试导致心跳超时，正式版本请勿设置）</p></td>
        </tr>

    
    </tbody>
</table>

            </td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	

	

	

	
</dl>


    

    

    

    

    

    

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="call"><span class="type-signature"></span>call(options)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>发起音视频呼叫</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>options</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>



            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>配置参数</p>
                <h6 class="method-params-label method-subparams-label">Properties</h6>
                

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>type</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>



            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            

            <td class="description last"><p><a href="Netcall.html#.NETCALL_TYPE_*"><code>通话类型</code></a></p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>account</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>



            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            

            <td class="description last"><p>对方账号</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>pushConfig</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            

            <td class="description last"><p>推送配置</p>
                <h6 class="method-params-label method-subparams-label">Properties</h6>
                

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>enable</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    true
                
                </td>
            

            <td class="description last"><p>是否需要推送, 默认 true</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>needBadge</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    true
                
                </td>
            

            <td class="description last"><p>是否需要角标计数, 默认 true</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>needPushNick</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    true
                
                </td>
            

            <td class="description last"><p>是否需要推送昵称, 默认 true</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>pushContent</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>推送内容</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>custom</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>自定义通知数据</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>pushPayload</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>JSON格式的推送 payload</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>sound</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>推送声音</p></td>
        </tr>

    
    </tbody>
</table>

            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>sessionConfig</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            

            <td class="description last"><p>会话配置</p></td>
        </tr>

    
    </tbody>
</table>

            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>option.sessionConfig.videoEncodeMode</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p><a href="Netcall.html#.CHAT_VIDEO_ENCODEMODE_*"><code>视频编码策略</code></a>，默认清晰优先</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>options.sessionConfig.videoQuality</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p><a href="Netcall.html#.CHAT_VIDEO_QUALITY_*"><code>视频分辨率</code></a>，实际帧率因画面采集频率和机器性能限制可能达不到期望值<br> 注：该参数发送给对方的分辨率，如果摄像头的分辨率比这个大会缩小，如果摄像头的分辨率比这个小则直接发送</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>options.sessionConfig.videoFrameRate</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p><a href="Netcall.html#.CHAT_VIDEO_FRAME_RATE_*"><code>视频帧率</code></a></p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>options.sessionConfig.videoBitrate</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>视频码率, &gt;=100000 &lt;= 5000000 有效</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>options.sessionConfig.highAudio</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    false
                
                </td>
            

            <td class="description last"><p>高清语音开关, 默认关闭</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>options.sessionConfig.recordVideo</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    false
                
                </td>
            

            <td class="description last"><p>视频录制开关, 默认关闭</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>options.sessionConfig.recordAudio</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    false
                
                </td>
            

            <td class="description last"><p>音频录制开关, 默认关闭</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="control"><span class="type-signature"></span>control(options)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>发送音视频通话控制指令</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>options</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>



            
            </td>

            

            
                <td class="default">
                
                    {}
                
                </td>
            

            <td class="description last"><p>配置参数</p>
                <h6 class="method-params-label method-subparams-label">Properties</h6>
                

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>channelId</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            

            <td class="description last"><p>要发送指令的通话的 channelId, 如果不填那么默认为当前通话</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>command</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            

            <td class="description last"><p>可选控制指令请参考 <a href="Netcall.html#.NETCALL_CONTROL_COMMAND_*"><code>Netcall.NETCALL_CONTROL_COMMAND_*</code></a></p></td>
        </tr>

    
    </tbody>
</table>

            </td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Void</span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="createChannel"><span class="type-signature"></span>createChannel(options)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>创建频道</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>options</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>



            
            </td>

            

            

            <td class="description last"><p>配置参数</p>
                <h6 class="method-params-label method-subparams-label">Properties</h6>
                

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>channelName</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>



            
            </td>

            

            

            <td class="description last"><p>频道名称</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>custom</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>



            
            </td>

            

            

            <td class="description last"><p>扩展字端（用于上层放自定义数据，选填）</p></td>
        </tr>

    
    </tbody>
</table>

            </td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="getAccount"><span class="type-signature"></span>getAccount()</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>获取当前登录的 IM 账号</p>
    </div>
    

    

    

    
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">String</span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="getStartedDeviceOfType"><span class="type-signature"></span>getStartedDeviceOfType(type)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>获取当前开启的指定类型的设备</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>type</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>



            
            </td>

            

            

            <td class="description last"><p>可选设备类型请参考 <a href="Netcall.html#.DEVICE_TYPE_*"><code>Netcall.DEVICE_TYPE_*</code></a></p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Void</span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="getStoredDevicesOfType"><span class="type-signature"></span>getStoredDevicesOfType(type)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>获取已经存储的指定类型的所有设备</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>type</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>



            
            </td>

            

            

            <td class="description last"><p>可选设备类型请参考 <a href="Netcall.html#.DEVICE_TYPE_*"><code>Netcall.DEVICE_TYPE_*</code></a></p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Void</span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="hangup"><span class="type-signature"></span>hangup( [channelId])</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>挂断音视频通话</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>channelId</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            

            <td class="description last"><p>要挂断的通话的 channelId, 如果不填那么挂断当前通话</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Void</span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="hasDevicesOfType"><span class="type-signature"></span>hasDevicesOfType(type)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>是否有指定类型的设备<br> 返回对应的设备信息</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>type</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>



            
            </td>

            

            

            <td class="description last"><p>可选设备类型请参考 <a href="Netcall.html#.DEVICE_TYPE_*"><code>Netcall.DEVICE_TYPE_*</code></a></p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Void</span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="hasStartedDeviceOfType"><span class="type-signature"></span>hasStartedDeviceOfType(type)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>当前是否有开启指定类型的设备</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>type</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>



            
            </td>

            

            

            <td class="description last"><p>可选设备类型请参考 <a href="Netcall.html#.DEVICE_TYPE_*"><code>Netcall.DEVICE_TYPE_*</code></a></p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Boolean</span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="initSignal"><span class="type-signature"></span>initSignal()</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>初始化信令</p>
<ul>
<li>信令通道初始化完毕之后, 开发者可以启用音视频相关的 UI, 比如说展示呼叫别人的按钮</li>
<li>信令通道初始化失败的时候, 请展示错误并禁用所有音视频相关的 UI</li>
<li>初始化过程中会通过 devices 事件回传所有的设备列表</li>
<li>当信令通道断开时, 会触发 signalClosed 事件</li>
<li>设备状态的错误类型约定:<br>device_busy: 设备被占用<br>agent_update: 插件有更新<br>agent_empty: 没有安装插件</li>
</ul>
    </div>
    

    

    

    
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="isCurrentChannelId"><span class="type-signature"></span>isCurrentChannelId()</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>是当前会话的 channelId</p>
    </div>
    

    

    

    
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Boolean</span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="joinChannel"><span class="type-signature"></span>joinChannel(options)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>主动加入频道</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>options</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>



            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>音视频相关配置参数</p>
                <h6 class="method-params-label method-subparams-label">Properties</h6>
                

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>channelName</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>



            
            </td>

            

            

            <td class="description last"><p>频道名称</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>type</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>



            
            </td>

            

            

            <td class="description last"><p><a href="Netcall.html#.NETCALL_TYPE_*"><code>通话类型</code></a></p></td>
        </tr>

    
    </tbody>
</table>

            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>option.liveEnable</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>



            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>是否开启旁路直播，可选 true / false(默认不开启)</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>options.sessionConfig</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>



            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>会话配置</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>option.sessionConfig.videoEncodeMode</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p><a href="Netcall.html#.CHAT_VIDEO_ENCODEMODE_*"><code>视频编码策略</code></a>，默认流畅优先(暂不支持实时设置)</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>options.sessionConfig.videoQuality</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>



            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p><a href="Netcall.html#.CHAT_VIDEO_QUALITY_*"><code>视频分辨率</code></a>，实际效果因画面采集频率和机器性能限制可能达不到期望值</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>options.sessionConfig.videoFrameRate</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>



            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p><a href="Netcall.html#.CHAT_VIDEO_FRAME_RATE_*"><code>视频帧率</code></a>，实际效果因画面采集频率和机器性能限制可能达不到期望值</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>options.sessionConfig.videoBitrate</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>



            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>视频码率, &gt;=100000 &lt;= 5000000 有效</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>options.sessionConfig.highAudio</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    false
                
                </td>
            

            <td class="description last"><p>高清语音开关, 默认关闭</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>options.sessionConfig.recordVideo</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    false
                
                </td>
            

            <td class="description last"><p>视频录制开关, 默认关闭</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>options.sessionConfig.recordAudio</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    false
                
                </td>
            

            <td class="description last"><p>音频录制开关, 默认关闭</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>options.sessionConfig.rtmpUrl</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>



            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>推流地址</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>options.sessionConfig.rtmpRecord</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    false
                
                </td>
            

            <td class="description last"><p>推流服务端录制开关, 默认关闭</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>options.sessionConfig.splitMode</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>



            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>推流的布局, <a href="Netcall.html#.LAYOUT_*"><code>布局类型</code></a>默认平铺</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>options.sessionConfig.layout</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>



            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>自定义布局，当主播选择推流布局为: LAYOUT_SPLITCUSTOMLAYOUT 和 LAYOUT_SPLITAUDIOLAYOUT 模式时生效</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="leaveChannel"><span class="type-signature"></span>leaveChannel()</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>离开频道</p>
    </div>
    

    

    

    
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="netDetect"><span class="type-signature"></span>netDetect( [type] [, quality])</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>网络探测</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>type</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    Netcall.NETDETECT_AUDIO
                
                </td>
            

            <td class="description last"><p><a href="Netcall.html#.NETDETECT_*"><code>探测类型</code></a></p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>quality</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    Netcall.CHAT_VIDEO_QUALITY_NORMAL
                
                </td>
            

            <td class="description last"><p><a href="Netcall.html#.CHAT_VIDEO_QUALITY_*"><code>探测质量分辨率</code></a></p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Void</span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="notCurrentChannelId"><span class="type-signature"></span>notCurrentChannelId()</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>不是当前会话的 channelId</p>
    </div>
    

    

    

    
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Boolean</span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="response"><span class="type-signature"></span>response( [options])</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>响应音视频被呼叫</p>
<p> 调用此接口前需要先初始化信令</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>options</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    {}
                
                </td>
            

            <td class="description last"><p>配置参数</p>
                <h6 class="method-params-label method-subparams-label">Properties</h6>
                

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>accepted</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    true
                
                </td>
            

            <td class="description last"><p>true 接听, false 拒绝</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>beCalledInfo</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>



            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>被呼叫的信息, 在 beCalling 事件里可以接收到的信息</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>sessionConfig</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>会话配置</p></td>
        </tr>

    
    </tbody>
</table>

            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>option.sessionConfig.videoEncodeMode</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p><a href="Netcall.html#.CHAT_VIDEO_ENCODEMODE_*"><code>视频编码策略</code></a>，默认清晰优先</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>options.sessionConfig.videoQuality</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p><a href="Netcall.html#.CHAT_VIDEO_QUALITY_*"><code>视频分辨率</code></a>，实际帧率因画面采集频率和机器性能限制可能达不到期望值<br> 注：该参数发送给对方的分辨率，如果摄像头的分辨率比这个大会缩小，如果摄像头的分辨率比这个小则直接发送</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>options.sessionConfig.videoFrameRate</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p><a href="Netcall.html#.CHAT_VIDEO_FRAME_RATE_*"><code>视频帧率</code></a></p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>options.sessionConfig.videoBitrate</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>视频码率, &gt;=100000 &lt;= 5000000 有效</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>options.sessionConfig.highAudio</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    false
                
                </td>
            

            <td class="description last"><p>高清语音开关, 默认关闭</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>options.sessionConfig.recordVideo</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    false
                
                </td>
            

            <td class="description last"><p>视频录制开关, 默认关闭</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>options.sessionConfig.recordAudio</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    false
                
                </td>
            

            <td class="description last"><p>音频录制开关, 默认关闭</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>options.sessionConfig.recordAudio</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    false
                
                </td>
            

            <td class="description last"><p>录制模式,0:参与混合录制并且录制单人文件 1:只参与混合录制 2:只录制单人文件</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>options.sessionConfig.recordType</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    0
                
                </td>
            

            <td class="description last"><p>音频录制开关, 默认关闭</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="resumeLocalStream"><span class="type-signature"></span>resumeLocalStream()</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>继续播放自己的视频画面 #废弃</p>
    </div>
    

    

    

    
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Void</span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="resumeRemoteStream"><span class="type-signature"></span>resumeRemoteStream()</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>继续播放对方的视频画面 #废弃 请使用startRemoteStream</p>
    </div>
    

    

    

    
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Void</span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="setAudioBlack"><span class="type-signature"></span>setAudioBlack(account)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>设置目标静音</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>account</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>



            
            </td>

            

            

            <td class="description last"><p>账号</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Void</span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="setAudioStart"><span class="type-signature"></span>setAudioStart(account)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>设置目标非静音</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>account</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>



            
            </td>

            

            

            <td class="description last"><p>账号</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Void</span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="setCaptureVolume"><span class="type-signature"></span>setCaptureVolume(num)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>设置采集音量</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>num</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>



            
            </td>

            

            

            <td class="description last"><p>音量大小, 0-255</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Void</span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="setPlayVolume"><span class="type-signature"></span>setPlayVolume(options)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>设置播放音量</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>options</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>



            
            </td>

            

            
                <td class="default">
                
                    {}
                
                </td>
            

            <td class="description last"><p>配置参数</p>
                <h6 class="method-params-label method-subparams-label">Properties</h6>
                

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>volume</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>



            
            </td>

            

            

            <td class="description last"><p>音量大小, 0-255, 必填</p></td>
        </tr>

    
    </tbody>
</table>

            </td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Void</span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="setVideoScale"><span class="type-signature"></span>setVideoScale(options)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>裁剪画面尺寸和比例: 不裁剪 / 1:1 / 4:3 / 16 : 9</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>options</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>



            
            </td>

            

            
                <td class="default">
                
                    {}
                
                </td>
            

            <td class="description last"><p>配置参数</p>
                <h6 class="method-params-label method-subparams-label">Properties</h6>
                

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>account</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>



            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>对象账号，不填操作全部远程流</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>type</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    Netcall.CHAT_VIDEO_SCALE_None
                
                </td>
            

            <td class="description last"><p>裁剪比例，默认不裁剪，选值类型请参考 <a href="Netcall.html#.CHAT_VIDEO_SCALE_*"><code>Netcall.CHAT_VIDEO_SCALE_*</code></a></p></td>
        </tr>

    
    </tbody>
</table>

            </td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="setVideoViewRemoteSize"><span class="type-signature"></span>setVideoViewRemoteSize(options)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>设置对方画面的尺寸</p>
<p> 最终显示的画面不大于所设置的宽和高<br> 备注：视频画面大小设置完全基于摄像头开启的大小，如果设置的大小超过摄像头开启的大小，结果以摄像头开启尺寸为准!</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>options</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>



            
            </td>

            

            
                <td class="default">
                
                    {}
                
                </td>
            

            <td class="description last"><p>配置参数</p>
                <h6 class="method-params-label method-subparams-label">Properties</h6>
                

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>account</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>



            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>对象账号，不填操作全部远程流</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>width</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>



            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>宽度</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>height</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>



            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>高度</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>cut</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    true
                
                </td>
            

            <td class="description last"><p>是否需要剪裁, 默认按1：1比例剪裁(画面不变形), cut: true, 画面按照提供的宽高等比例裁剪，返回裁剪后的实际大小, cut: false, 画面不进行裁剪, 返回按原始宽高比例放大缩小后的实际宽高<br> 注: agent为了解决绿屏的问题，宽高需要设置为8的倍数，即使开发者设置的不是8的倍数，agent也会计算出不超过所设置宽高的最接近8的倍数的宽高</p></td>
        </tr>

    
    </tbody>
</table>

            </td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="setVideoViewSize"><span class="type-signature"></span>setVideoViewSize(options)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>设置自己画面的尺寸</p>
<p> 最终显示的画面不大于所设置的宽和高<br> 备注：视频画面大小设置完全基于摄像头开启的大小，如果设置的大小超过摄像头开启的大小，结果以摄像头开启尺寸为准!</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>options</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>



            
            </td>

            

            
                <td class="default">
                
                    {}
                
                </td>
            

            <td class="description last"><p>配置参数</p>
                <h6 class="method-params-label method-subparams-label">Properties</h6>
                

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>width</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>



            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>宽度</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>height</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>



            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>高度</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>cut</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    true
                
                </td>
            

            <td class="description last"><p>是否需要剪裁, 默认按1：1比例剪裁(画面不变形), cut: true, 画面按照提供的宽高等比例裁剪，返回裁剪后的实际大小, cut: false, 画面不进行裁剪, 返回按原始宽高比例放大缩小后的实际宽高<br> 注: agent为了解决绿屏的问题，宽高需要设置为8的倍数，即使开发者设置的不是8的倍数，agent也会计算出不超过所设置宽高的最接近8的倍数的宽高</p></td>
        </tr>

    
    </tbody>
</table>

            </td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="startDevice"><span class="type-signature"></span>startDevice(options)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>开启设备</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>options</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>



            
            </td>

            

            

            <td class="description last"><p>配置参数</p>
                <h6 class="method-params-label method-subparams-label">Properties</h6>
                

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>type</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>



            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            

            <td class="description last"><p>设备类型</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>device</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            

            <td class="description last"><p>设备, 如果没有指定, 那么开启该类型的第一个设备</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>width</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            

            <td class="description last"><p>如果启动视频设备, 设置摄像头捕获的视频的最大宽度</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>height</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            

            <td class="description last"><p>如果启动视频设备, 设置摄像头捕获的视频的最大高度</p></td>
        </tr>

    
    </tbody>
</table>

            </td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="startLocalStream"><span class="type-signature"></span>startLocalStream(node)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>开启本地视频流</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>node</code></td>
            

            <td class="type">
            
                
<span class="param-type">Node</span>



            
            </td>

            

            

            <td class="description last"><p>本地视频流dom节点 可选</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Void</span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="startRecordAac"><span class="type-signature"></span>startRecordAac(options)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>混音本地录制（所有流一起录）</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>options</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>



            
            </td>

            

            

            <td class="description last">
                <h6 class="method-params-label method-subparams-label">Properties</h6>
                

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>path</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>



            
            </td>

            

            

            <td class="description last"><p>路径地址 如E:\wenjian\abc.aac</p></td>
        </tr>

    
    </tbody>
</table>

            </td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="startRecordMp4"><span class="type-signature"></span>startRecordMp4(options)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>本地录制（录自己） 请监听recordMp4事件为正式开始录制回调 netcall.on('recordMp4',function(data){})</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>options</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>



            
            </td>

            

            

            <td class="description last">
                <h6 class="method-params-label method-subparams-label">Properties</h6>
                

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>path</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>



            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>路径地址 如E:\wenjian\abc.mp4</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>account</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>需要录制的目标，默认录制自己</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>aac</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    false
                
                </td>
            

            <td class="description last"><p>是否需要混音录制，默认关闭</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>recode</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    true
                
                </td>
            

            <td class="description last"><p>是否允许视频重新编码，默认开启</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>width</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>录制Mp4的宽度，默认为0，小于16无效，无效时取视频默认宽度</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>height</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>录制Mp4的高度，默认为0，小于16无效，无效时取视频默认高度</p></td>
        </tr>

    
    </tbody>
</table>

            </td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Void</span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="startRemoteStream"><span class="type-signature"></span>startRemoteStream(options)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>开启远程视频流</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>options</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>



            
            </td>

            

            
                <td class="default">
                
                    {}
                
                </td>
            

            <td class="description last"><p>配置参数</p>
                <h6 class="method-params-label method-subparams-label">Properties</h6>
                

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>account</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>



            
            </td>

            

            

            <td class="description last"><p>账号, 不设置则操作所有远程流</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>node</code></td>
            

            <td class="type">
            
                
<span class="param-type">Node</span>



            
            </td>

            

            

            <td class="description last"><p>视频画面显示的dom容器节点</p></td>
        </tr>

    
    </tbody>
</table>

            </td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Void</span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="stopDevice"><span class="type-signature"></span>stopDevice(type)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>停止指定类型的设备</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>type</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>



            
            </td>

            

            

            <td class="description last"><p>可选设备类型请参考 <a href="Netcall.html#.DEVICE_TYPE_*"><code>Netcall.DEVICE_TYPE_*</code></a></p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Void</span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="stopLocalStream"><span class="type-signature"></span>stopLocalStream()</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>停止本地视频流</p>
    </div>
    

    

    

    
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Void</span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="stopRecordAac"><span class="type-signature"></span>stopRecordAac()</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>停止混音本地录制</p>
    </div>
    

    

    

    
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="stopRecordMp4"><span class="type-signature"></span>stopRecordMp4()</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>停止本地录制（录自己）</p>
    </div>
    

    

    

    
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="stopRemoteStream"><span class="type-signature"></span>stopRemoteStream(account)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>关闭远程视频流</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>account</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>



            
            </td>

            

            

            <td class="description last"><p>对应的nim账号, 不设置则操作所有远程流</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Void</span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="stopSignal"><span class="type-signature"></span>stopSignal()</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>停止信令通道</p>
    </div>
    

    

    

    
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="suspendLocalStream"><span class="type-signature"></span>suspendLocalStream()</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>暂停播放自己的视频画面 #废弃</p>
    </div>
    

    

    

    
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Void</span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="suspendRemoteStream"><span class="type-signature"></span>suspendRemoteStream()</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>暂停播放对方的视频画面 #废弃 请使用stopRemoteStream</p>
    </div>
    

    

    

    
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Void</span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="switchAudioToVideo"><span class="type-signature"></span>switchAudioToVideo()</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>从音频模式切换为视频模式</p>
    </div>
    

    

    

    
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Void</span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="switchVideoToAudio"><span class="type-signature"></span>switchVideoToAudio()</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>从视频模式切换为音频模式</p>
    </div>
    

    

    

    
    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Void</span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="updateRtmpUrl"><span class="type-signature"></span>updateRtmpUrl(url)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>更新推流地址</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>url</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>



            
            </td>

            

            

            <td class="description last"><p>新地址</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	

	

    

    

    

    

	

	

	

	

	



	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>



    </dd>
</dl>


        

    
</dd>

        </dl>
    

    

    
</article>

</section>




		</div>
	</div>

	<div class="clearfix"></div>

	
		<div class="col-md-3">
			<div id="toc" class="col-md-3 hidden-xs hidden-sm hidden-md"></div>
		</div>
	

</div>
</div>


    <div class="modal fade" id="searchResults">
      <div class="modal-dialog">
        <div class="modal-content">
          <div class="modal-header">
            <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">&times;</span></button>
            <h4 class="modal-title">Search results</h4>
          </div>
          <div class="modal-body"></div>
          <div class="modal-footer">
            <button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
          </div>
        </div><!-- /.modal-content -->
      </div><!-- /.modal-dialog -->
    </div>


<footer>


<span class="jsdoc-message">
	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
	
		on 2020-05-11T17:02:55+08:00
	
	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
</footer>

<script src="scripts/docstrap.lib.js"></script>
<script src="scripts/toc.js"></script>

    <script type="text/javascript" src="scripts/fulltext-search-ui.js"></script>


<script>
$( function () {
	$( "[id*='$']" ).each( function () {
		var $this = $( this );

		$this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) );
	} );

	$( ".tutorial-section pre, .readme-section pre, pre.prettyprint.source" ).each( function () {
		var $this = $( this );

		var example = $this.find( "code" );
		exampleText = example.html();
		var lang = /{@lang (.*?)}/.exec( exampleText );
		if ( lang && lang[1] ) {
			exampleText = exampleText.replace( lang[0], "" );
			example.html( exampleText );
			lang = lang[1];
		} else {
			var langClassMatch = example.parent()[0].className.match(/lang\-(\S+)/);
			lang = langClassMatch ? langClassMatch[1] : "javascript";
		}

		if ( lang ) {

			$this
			.addClass( "sunlight-highlight-" + lang )
			.addClass( "linenums" )
			.html( example.html() );

		}
	} );

	Sunlight.highlightAll( {
		lineNumbers : false,
		showMenu : true,
		enableDoclinks : true
	} );

	$.catchAnchorLinks( {
        navbarOffset: 10
	} );
	$( "#toc" ).toc( {
		anchorName  : function ( i, heading, prefix ) {
			return $( heading ).attr( "id" ) || ( prefix + i );
		},
		selectors   : "#toc-content h1,#toc-content h2,#toc-content h3,#toc-content h4",
		showAndHide : false,
		smoothScrolling: true
	} );

	$( "#main span[id^='toc']" ).addClass( "toc-shim" );
	$( '.dropdown-toggle' ).dropdown();

    $( "table" ).each( function () {
      var $this = $( this );
      $this.addClass('table');
    } );

} );
</script>



<!--Navigation and Symbol Display-->


<!--Google Analytics-->



    <script type="text/javascript">
        $(document).ready(function() {
            SearcherDisplay.init();
        });
    </script>


</body>
</html>